/*
 * Copyright (c) 2008-2010, Matthias Mann
 *
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 *     * Redistributions of source code must retain the above copyright notice,
 *       this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *     * Neither the name of Matthias Mann nor the names of its contributors may
 *       be used to endorse or promote products derived from this software
 *       without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package de.matthiasmann.twl.textarea;

import de.matthiasmann.twl.utils.TextUtil;

/**
 * Number formatting for ordered lists
 *
 * @author Matthias Mann
 */
public class OrderedListType {

    public static final OrderedListType DECIMAL = new OrderedListType();
    
    protected final String characterList;

    /**
     * Creates a new OrderedListType which just uses {@link Integer#toString(int) }
     */
    public OrderedListType() {
        this.characterList = null;
    }

    /**
     * Creates a new OrderedListType which uses {@link TextUtil#toCharListNumber(int, java.lang.String) }
     * for positive numbers and {@link Integer#toString(int) } for the rest.
     *
     * @param characterList the character list
     */
    public OrderedListType(String characterList) {
        this.characterList = characterList;
    }

    /**
     * Convert the number into a String
     * @param nr the number
     * @return the String which represents the number
     */
    public String format(int nr) {
        if(nr >= 1 && characterList != null) {
            return TextUtil.toCharListNumber(nr, characterList);
        } else {
            return Integer.toString(nr);
        }
    }
}
